improvement: add `redirects` config, and documentation explaining it #1952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

josevalim merged 11 commits into elixir-lang:main from zachdaniel:redirects

Sep 17, 2024

Contributor

zachdaniel commented Sep 17, 2024 •

edited

Loading

Proposed solution for #1951

zachdaniel commented

View reviewed changes

lib/ex_doc/formatter/html.ex Outdated Show resolved Hide resolved


          improvement: add redirects config, and documentation explaining it

c045169

zachdaniel force-pushed the redirects branch from c6088a1 to c045169 Compare

September 17, 2024 12:44

zachdaniel added 2 commits

September 17, 2024 08:47


          chore: update docs to be more clear

8713a5b


          chore: grammar

64ad8f2

zachdaniel commented

View reviewed changes

README.md Outdated Show resolved Hide resolved

josevalim reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved


          Update README.md

Co-authored-by: José Valim <jose.valim@gmail.com>

josevalim reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved


          Update README.md

897b7b6

Co-authored-by: José Valim <jose.valim@gmail.com>

josevalim reviewed

View reviewed changes

lib/ex_doc/formatter/html.ex Outdated Show resolved Hide resolved


          Update lib/ex_doc/formatter/html.ex

09ba90a

Co-authored-by: José Valim <jose.valim@gmail.com>

josevalim reviewed

View reviewed changes

mix.exs Outdated Show resolved Hide resolved

josevalim reviewed

View reviewed changes

README.md Show resolved Hide resolved

zachdaniel added 2 commits

September 17, 2024 12:28


          PR Feedback

83551f8


          chore: format

000c028

josevalim reviewed

View reviewed changes

lib/ex_doc/formatter/html.ex Show resolved Hide resolved

zachdaniel added 3 commits

September 17, 2024 14:01


          fix: handle lists in redirects properly, add corresponding test

a5dc896


          chore: add whitespace to readme

6fec117


          chore: format

josevalim merged commit 2c1a895 into elixir-lang:main

5 checks passed

Member

josevalim commented Sep 17, 2024

💚 💙 💜 💛 ❤️

Member

josevalim commented Sep 17, 2024

Excellent turn around here, thank you!

Contributor

garazdawi commented Sep 18, 2024

Excellent feature! I'm a bit late to the party, but would it not be good to add this option to the list of options in https://github.com/elixir-lang/ex_doc/blob/main/lib/mix/tasks/docs.ex? So that we have a common list for all options available?

Member

josevalim commented Sep 18, 2024

Yes, it would be good indeed. :) @zachdaniel, please let me know if you can do it or if you'd prefer for us to push it.

Contributor Author

zachdaniel commented Sep 18, 2024

Will add when I'm at a computer 👍👍

Contributor Author

zachdaniel commented Sep 18, 2024

PR here: https://github.com/elixir-lang/ex_doc/pull/1953/files

garazdawi mentioned this pull request

Swup Error #2094

Closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet